Add sustainability modules to mapping documentation #422
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
duncandewhurst
requested review from
odscjen and
jpmckinney
and removed request for
odscjen
7 tasks
|
For spellcheck, change |
jpmckinney
reviewed
Nov 2, 2023
Yep, that's correct. |
jpmckinney
reviewed
Nov 3, 2023
|
I realised that |
jpmckinney
reviewed
Nov 6, 2023
docs/cost/ids/core.md
Outdated
|
|
||
| This page documents a mapping from the 'core' CoST IDS elements to OC4IDS fields and codes. The organization of the mapping tables reflects the structure of the CoST IDS. | ||
|
|
||
| The CoST IDS sets out a number of disclosure requirements under the heading of 'information for disclosure upon request', also known as 'reactive disclosure'. You can disclose these elements proactively using OC4IDS. Separate tables are provided for project-level and process-level reactive disclosures. |
There was a problem hiding this comment.
Should this paragraph also be present in ocds.md?
There was a problem hiding this comment.
Yes! Added in a198afb
Co-authored-by: James McKinney <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issues
Description
The mapping is stored in
sustainability.yamland there are two newmanage.pycommands:update-sustainability-docsgenerates the Markdown content indocs/cost/ids/sustainability.mdusingsustainability.yaml.lintformats and validates the data insustainability.yamland reports missing dataPresently,
lintreports many additional fields and some missing data. This is expected because the schema is not yet updated and because the mapping for some elements is still under discussion.However, I suggest that we merge this PR as-is and then, as part of each schema or codelist change PR, we can update the relevant mappings and examples in
sustainability.yaml.Before releasing, OC4IDS 0.9.4 we can do a final copy edit of the mappings and examples for consistency and check that
lintreports no additional fields or missing data. I'll create a separate issue about that.The spell-check is failing on the "TNE" unit code referenced in the mapping. @jpmckinney is there somewhere that needs to be added to a dictionary?
Merge checklist
If there are changes to
project-schema.jsonorproject-package-schema.json:docs/examples/example.jsondocs/examples/blank.json./manage.py pre-committo updatedocs/_static/i8n.csvIf you added a new definition to the schema, run
./manage.py pre-commit.If you added a new codelist:
docs/reference/codelists.md